3.3 查询本地组织架构列表
基本信息
Path：/api/v1/directory/queryEntity
Method： POST
接口描述：
- 查询组织架构时，需要在include中添加一个group对象，group对象下面放pageSize和pageIndex，并构造相应的条件来查询
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
| 参数名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| userDirectoryId | string | 必须 | 用户目录ID，默认的本地用户目录ID为1 | 可通过用户目录查询接口获取ID | |
| showAll | number | 非必须 | 1 | 查询所有，1递归查询组织架构下属的所有数据，0只查询直属的数据 | |
| include | object[] | 必须 | 查询条件 | ||
| ├─group | object | 必须 | 组织架构的查询条件 | ||
| ├─├─pageSize | number | 非必须 | 20 | 分页大小，每页查询的最大数据量，越大查询时间越长 | |
| ├─├─pageIndex | number | 非必须 | 1 | 页码 | |
| path | string | 非必须 | '/' | 查询条件：组织架构路径，查询某个组织架构下属数据 |
请求示例
{
"userDirectoryId": "1",
"showAll": 1,
"include": {
"group": {
"pageSize": 20,
"pageIndex": 1
}
}
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | number | 必须 | 返回码，0 返回成功 | ||
| data | object | 必须 | 报文数据主体 | ||
| ├─group | object | 必须 | 组织架构列表查询结果数据主体 | ||
| ├─├─ count | number | 必须 | 查询结果的数据总数 | ||
| ├─├─ pageCount | number | 必须 | 查询结果的数据总页数 | ||
| ├─├─ pageSize | number | 必须 | 页大小，每页的最大数据数 | ||
| ├─├─ pageIndex | number | 必须 | 页码 | ||
| ├─├─ data | object[] | 必须 | 查询结果数据主体 | ||
| ├─├─├─ id | string | 必须 | 组ID | ||
| ├─├─├─ name | string | 必须 | 组名称 | ||
| ├─├─├─ path | string | 必须 | 所属组路径 | ||
| ├─├─├─ description | string | 必须 | 描述 | ||
| ├─├─├─ entityType | string | 必须 | 实体类型，'group' | ||
| ├─├─├─ createdAt | string | 必须 | 创建时间 | ||
| ├─├─├─ updatedAt | string | 必须 | 更新时间 | ||
| msg | string | 必须 | 返回提示信息，与返回码对应 |
返回示例
{
"code": 0,
"data": {
"group": {
"data": [{
"id": "908b7415-a333-11eb-bc20-21be2d4cebdc",
"name": "test002",
"path": "/深信服科技/ssl/test1test1test1test1test1",
"description": "",
"entityType": "group",
"createdAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)",
"updatedAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)"
},
{
"id": "908b4d05-a333-11eb-bc20-21be2d4cebdc",
"name": "test1test1test1test1test1",
"path": "/深信服科技/ssl",
"description": "",
"entityType": "group",
"createdAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)",
"updatedAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)"
}],
"count": 2,
"pageCount": 1,
"pageSize": 2000,
"pageIndex": 1
}
},
"msg": "请求成功"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 10000001 |
| 用户目录不存在 | 77200001 |